Description générale du format.PT
|
Un fichier au format .PT (plain text) est assez semblable aux fichiers .TEX du traitement de texte TeX ou LaTeX. Il se présente sous la forme d'un texte sans mise en forme et de commandes (macro du préprocesseur C++) de formatage de ce texte. Ces commandes sont prédéfinies dans le fichier de macros .MAC automatiquement inclu, ou peuvent être créees directement en se conformant à la syntaxe du préprocesseur C++.
Un fichier au format .PT doit impérativement débuter par la macro _Begin et se terminer par la macro _End. Il se compose simplement d'une série de rubriques qui correspondent chacune à une page hypertexte lorsq'un fichier d'aide windows est généré.
A l'intérieur de chaque rubrique, la mise en forme des paragraphes s'effectue, entre autres, par des commandes de délimitation d' environnement ou des commandes de mise en forme de caractères.
_Begin
_bFirstPage(Titre,Name,mots-clés)
_bitemize
_item _ref(Présentation,first)
_item _ref(Description,second)
_eitemize
_eFirstPage
_bPage(Présentation,first)
retour au _ref(Sommaire,Top)
_ePage
_bPage(Description,second)
...
_ePage
_End
Environnement
|
Un environnement est une syntaxe inspirée de TeX.
Un environnement env sera délimité par les mots-clés
_benv et _eenv.
Certain environnements possèdent également une ou plusieurs macros de délimitation interne.
Ces macros seront le plus souvent nommées _nenv
(tel que _nexample pour example, _ncode pour code),
ou bien portent des noms spécifiques :
(_item pour itemize et enumerate),
(_rexample pour example).
Les environnements ne peuvent être entrelacés. En revanche, certains environnements peuvent être imbriqués:
example peut contenir un
environnement de paragraphes ou un
environnement de caractères.
example
Un mot sur la syntaxe
|
Afin de singulariser les macros (mots-clés) à l'intérieur du texte et de faciliter la reconnaissance de la syntaxe, la règle
Toute macro commence par le caractère "_".
a été scrupuleusement observée. De plus
Les macro. à usage interne ou de paramètrage commencent par 2 caractères "_".
Par ailleurs, à l'exception de _ref, _ref1 et _Tex, il semble que la règle suivante soit toujours vérifiée
L'usage des majuscules dans le nom de la macro indique que celle-ci possède des arguments.
Il est à noter que cette dernière règle s'est trouvée vérifiée de manière tout à fait involontaire.
Il est bien sur fortement recommandé d'observer ces règles dans tout développement du langage PT.